Merge pull request #361 from specklesystems/dev

Main to dev

src/Speckle.Sdk/Caching/FileSystem.cs

@@ -0,0 +1,22 @@
+using Speckle.InterfaceGenerator;
+
+namespace Speckle.Sdk.Caching;
+
+/// <summary>
+/// This mocks away the file system operations for testing purposes.
+/// </summary>
+[GenerateAutoInterface]
+public class FileSystem : IFileSystem
+{
+  public bool DirectoryExists(string path) => Directory.Exists(path);
+
+  public void CreateDirectory(string path) => Directory.CreateDirectory(path);
+
+  public IEnumerable<string> EnumerateFiles(string path) => Directory.EnumerateFiles(path);
+
+  public void DeleteFile(string path) => File.Delete(path);
+
+  public long GetFileSize(string path) => new FileInfo(path).Length;
+
+  public string Combine(params string[] paths) => Path.Combine(paths);
+}

src/Speckle.Sdk/Caching/ModelCacheManager.cs

@@ -0,0 +1,93 @@
+using Microsoft.Extensions.Logging;
+using Speckle.InterfaceGenerator;
+using Speckle.Sdk.Logging;
+using Speckle.Sdk.Transports;
+
+namespace Speckle.Sdk.Caching;
+
+/// <summary>
+/// This class manages the cache for model data, providing methods to get stream paths, clear the cache, and calculate cache size.
+/// </summary>
+[GenerateAutoInterface]
+public class ModelCacheManager(ILogger<ModelCacheManager> logger, IFileSystem fileSystem) : IModelCacheManager
+{
+  private const string DATA_FOLDER = "Projects";
+  private static readonly string s_basePath = SpecklePathProvider.UserSpeckleFolderPath;
+
+  private static string CacheFolder => Path.Combine(s_basePath, DATA_FOLDER);
+
+  public string GetStreamPath(string streamId) => GetDbPath(streamId);
+
+  public static string GetDbPath(string streamId)
+  {
+    var db = Path.Combine(CacheFolder, $"{streamId}.db");
+    try
+    {
+      Directory.CreateDirectory(CacheFolder); //ensure dir is there
+      return db;
+    }
+    catch (Exception ex)
+      when (ex is ArgumentException or IOException or UnauthorizedAccessException or NotSupportedException)
+    {
+      throw new TransportException($"Path was invalid or could not be created {db}", ex);
+    }
+  }
+
+  public void ClearCache()
+  {
+    try
+    {
+      if (!fileSystem.DirectoryExists(CacheFolder))
+      {
+        return;
+      }
+
+      foreach (var db in fileSystem.EnumerateFiles(CacheFolder))
+      {
+        try
+        {
+          fileSystem.DeleteFile(db);
+        }
+        catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or NotSupportedException)
+        {
+          logger.LogWarning(ex, "Failed to delete cache file {filePath}", db);
+        }
+      }
+    }
+    catch (Exception ex)
+      when (ex is ArgumentException or IOException or UnauthorizedAccessException or NotSupportedException)
+    {
+      throw new TransportException($"Cache folder could not be cleared: {CacheFolder}", ex);
+    }
+  }
+
+  public long GetCacheSize()
+  {
+    try
+    {
+      if (!fileSystem.DirectoryExists(CacheFolder))
+      {
+        return 0;
+      }
+
+      long size = 0;
+      foreach (var file in fileSystem.EnumerateFiles(CacheFolder))
+      {
+        try
+        {
+          size += fileSystem.GetFileSize(file);
+        }
+        catch (Exception ex) when (ex is IOException or UnauthorizedAccessException or NotSupportedException)
+        {
+          logger.LogWarning(ex, "Failed to get size for cache file {a}", file);
+        }
+      }
+      return size;
+    }
+    catch (Exception ex)
+      when (ex is ArgumentException or IOException or UnauthorizedAccessException or NotSupportedException)
+    {
+      throw new TransportException($"Cache folder size could not be determined: {CacheFolder}", ex);
+    }
+  }
+}

src/Speckle.Sdk/Host/TypeLoader.cs

@@ -15,10 +15,14 @@ internal static class TypeLoader
   private static ConcurrentDictionary<string, Type> s_cachedTypes = new();
   private static ConcurrentDictionary<Type, string> s_fullTypeStrings = new();
   private static ConcurrentDictionary<PropertyInfo, JsonPropertyAttribute?> s_jsonPropertyAttribute = new();
+  private static readonly ConcurrentDictionary<PropertyInfo, bool> s_obsolete = new();
   private static ConcurrentDictionary<Type, IReadOnlyList<PropertyInfo>> s_propInfoCache = new();
 
   public static IEnumerable<LoadedType> Types => s_availableTypes;
 
+  public static bool IsObsolete(PropertyInfo property) =>
+    s_obsolete.GetOrAdd(property, p => p.IsDefined(typeof(ObsoleteAttribute), true));
+
   public static JsonPropertyAttribute? GetJsonPropertyAttribute(PropertyInfo property) =>
     s_jsonPropertyAttribute.GetOrAdd(property, p => p.GetCustomAttribute<JsonPropertyAttribute>(true));
 

src/Speckle.Sdk/Models/Base.cs

@@ -3,7 +3,6 @@ using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 using Speckle.Newtonsoft.Json;
 using Speckle.Newtonsoft.Json.Linq;
-using Speckle.Sdk.Common;
 using Speckle.Sdk.Helpers;
 using Speckle.Sdk.Host;
 using Speckle.Sdk.Serialisation;
@@ -92,8 +91,7 @@ public class Base : DynamicBase, ISpeckleObject
     var typedProps = @base.GetInstanceMembers();
     foreach (var prop in typedProps.Where(p => p.CanRead))
     {
-      bool isIgnored =
-        prop.IsDefined(typeof(ObsoleteAttribute), true) || prop.IsDefined(typeof(JsonIgnoreAttribute), true);
+      bool isIgnored = TypeLoader.IsObsolete(prop) || prop.IsDefined(typeof(JsonIgnoreAttribute), true);
       if (isIgnored)
       {
         continue;
@@ -193,30 +191,4 @@ public class Base : DynamicBase, ISpeckleObject
         return count;
     }
   }
-
-  /// <summary>
-  /// Creates a shallow copy of the current base object.
-  /// This operation does NOT copy/duplicate the data inside each prop.
-  /// The new object's property values will be pointers to the original object's property value.
-  /// </summary>
-  /// <returns>A shallow copy of the original object.</returns>
-  public Base ShallowCopy()
-  {
-    Type type = GetType();
-    Base myDuplicate = (Base)Activator.CreateInstance(type).NotNull();
-    myDuplicate.id = id;
-    myDuplicate.applicationId = applicationId;
-
-    foreach (var kvp in GetMembers())
-    {
-      var propertyInfo = type.GetProperty(kvp.Key);
-      if (propertyInfo is not null && !propertyInfo.CanWrite)
-      {
-        continue;
-      }
-      myDuplicate[kvp.Key] = kvp.Value;
-    }
-
-    return myDuplicate;
-  }
 }

src/Speckle.Sdk/Models/DynamicBase.cs

@@ -7,7 +7,7 @@ namespace Speckle.Sdk.Models;
 
 /// <summary>
 /// Base class implementing a bunch of nice dynamic object methods, like adding and removing props dynamically. Makes c# feel like json.
-/// <para>Orginally adapted from Rick Strahl 🤘</para>
+/// <para>Originally adapted from Rick Strahl 🤘</para>
 /// <para>https://weblog.west-wind.com/posts/2012/feb/08/creating-a-dynamic-extensible-c-expando-object</para>
 /// </summary>
 public class DynamicBase : DynamicObject, IDynamicMetaObjectProvider
@@ -84,6 +84,44 @@ public class DynamicBase : DynamicObject, IDynamicMetaObjectProvider
     }
   }
 
+  /// <summary>
+  /// Creates a shallow copy of the current base object.
+  /// This operation does NOT copy/duplicate the data inside each prop.
+  /// The new object's property values will be pointers to the original object's property value.
+  /// </summary>
+  /// <returns>A shallow copy of the original object.</returns>
+  public DynamicBase ShallowCopy()
+  {
+    Type type = GetType();
+    DynamicBase myDuplicate = (DynamicBase)(
+      Activator.CreateInstance(type) ?? throw new SpeckleException($"Failed to create instance of {type.Name}")
+    );
+
+    // Add dynamic members
+    foreach (var kvp in _properties)
+    {
+      myDuplicate._properties[kvp.Key] = kvp.Value;
+    }
+
+    var pinfos = TypeLoader.GetBaseProperties(type).Where(x => !TypeLoader.IsObsolete(x));
+    foreach (var pi in pinfos)
+    {
+      if (pi.CanWrite)
+      {
+        try
+        {
+          pi.SetValue(myDuplicate, pi.GetValue(this));
+        }
+        catch (Exception ex) when (!ex.IsFatal())
+        {
+          throw new SpeckleException($"Failed to set value for {type.Name}.{pi.Name}", ex);
+        }
+      }
+    }
+
+    return myDuplicate;
+  }
+
   /// <inheritdoc />
   /// <summary>
   /// Gets properties via the dot syntax.
@@ -232,7 +270,7 @@ public class DynamicBase : DynamicObject, IDynamicMetaObjectProvider
         .GetBaseProperties(GetType())
         .Where(x =>
         {
-          var hasObsolete = x.IsDefined(typeof(ObsoleteAttribute), true);
+          var hasObsolete = TypeLoader.IsObsolete(x);
 
           // If obsolete is false and prop has obsolete attr
           // OR

src/Speckle.Sdk/SQLite/SqLiteJsonCacheManagerFactory.cs

@@ -1,11 +1,11 @@
 using Speckle.InterfaceGenerator;
+using Speckle.Sdk.Caching;
 using Speckle.Sdk.Logging;
-using Speckle.Sdk.Serialisation.Utilities;
 
 namespace Speckle.Sdk.SQLite;
 
 [GenerateAutoInterface]
-public class SqLiteJsonCacheManagerFactory : ISqLiteJsonCacheManagerFactory
+public class SqLiteJsonCacheManagerFactory(IModelCacheManager modelCacheManager) : ISqLiteJsonCacheManagerFactory
 {
   public const int INITIAL_CONCURRENCY = 4;
 
@@ -16,5 +16,5 @@ public class SqLiteJsonCacheManagerFactory : ISqLiteJsonCacheManagerFactory
     Create(Path.Combine(SpecklePathProvider.UserApplicationDataPath(), "Speckle", $"{scope}.db"), 1);
 
   public ISqLiteJsonCacheManager CreateFromStream(string streamId) =>
-    Create(SqlitePaths.GetDBPath(streamId), INITIAL_CONCURRENCY);
+    Create(modelCacheManager.GetStreamPath(streamId), INITIAL_CONCURRENCY);
 }

src/Speckle.Sdk/Serialisation/Utilities/SqlitePaths.cs

@@ -1,30 +0,0 @@
-using Speckle.Sdk.Logging;
-using Speckle.Sdk.Transports;
-
-namespace Speckle.Sdk.Serialisation.Utilities;
-
-public static class SqlitePaths
-{
-  private const string APPLICATION_NAME = "Speckle";
-  private const string DATA_FOLDER = "Projects";
-  private static readonly string basePath = SpecklePathProvider.UserApplicationDataPath();
-
-  public static string BlobStorageFolder =>
-    SpecklePathProvider.BlobStoragePath(Path.Combine(basePath, APPLICATION_NAME));
-
-  public static string GetDBPath(string streamId)
-  {
-    var dir = Path.Combine(basePath, APPLICATION_NAME, DATA_FOLDER);
-    var db = Path.Combine(dir, $"{streamId}.db");
-    try
-    {
-      Directory.CreateDirectory(dir); //ensure dir is there
-      return db;
-    }
-    catch (Exception ex)
-      when (ex is ArgumentException or IOException or UnauthorizedAccessException or NotSupportedException)
-    {
-      throw new TransportException($"Path was invalid or could not be created {db}", ex);
-    }
-  }
-}

src/Speckle.Sdk/Transports/SQLiteTransport2.cs

@@ -3,9 +3,9 @@ using System.Diagnostics;
 using System.Text;
 using System.Timers;
 using Microsoft.Data.Sqlite;
+using Speckle.Sdk.Caching;
 using Speckle.Sdk.Logging;
 using Speckle.Sdk.Models;
-using Speckle.Sdk.Serialisation.Utilities;
 using Timer = System.Timers.Timer;
 
 namespace Speckle.Sdk.Transports;
@@ -28,7 +28,7 @@ public sealed class SQLiteTransport2 : IDisposable, ICloneable, ITransport, IBlo
   {
     _streamId = streamId;
 
-    _rootPath = SqlitePaths.GetDBPath(streamId);
+    _rootPath = ModelCacheManager.GetDbPath(streamId);
 
     _connectionString = $"Data Source={_rootPath};";
 
@@ -50,7 +50,7 @@ public sealed class SQLiteTransport2 : IDisposable, ICloneable, ITransport, IBlo
   private SqliteConnection Connection { get; set; }
   private readonly SemaphoreSlim _connectionLock = new(1, 1);
 
-  public string BlobStorageFolder => SqlitePaths.BlobStorageFolder;
+  public string BlobStorageFolder => SpecklePathProvider.UserSpeckleFolderPath;
 
   public void SaveBlob(Blob obj)
   {

tests/Speckle.Sdk.Tests.Unit/Helpers/Path.cs

@@ -18,7 +18,7 @@ public class SpecklePathTests
     }
     else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
     {
-      pattern = @"\/Users\/.*\/\.config";
+      pattern = @"\/Users\/.*\/Library\/Application Support";
     }
     else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
     {
@@ -57,7 +57,7 @@ public class SpecklePathTests
     }
     else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
     {
-      pattern = @"\/Users\/.*\/\.config";
+      pattern = @"\/Users\/.*\/Library\/Application Support";
     }
     else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
     {

tests/Speckle.Sdk.Tests.Unit/ModelCacheManagerMockTests.cs

@@ -0,0 +1,83 @@
+using FluentAssertions;
+using Microsoft.Extensions.Logging;
+using Moq;
+using Speckle.Sdk.Caching;
+using Speckle.Sdk.Testing;
+
+namespace Speckle.Sdk.Tests.Unit;
+
+public class ModelCacheManagerMockTests : MoqTest
+{
+  private readonly Mock<IFileSystem> _fileSystemMock;
+  private readonly ModelCacheManager _manager;
+
+  public ModelCacheManagerMockTests()
+  {
+    Mock<ILogger<ModelCacheManager>> loggerMock = Create<ILogger<ModelCacheManager>>(MockBehavior.Loose);
+    _fileSystemMock = Create<IFileSystem>();
+    _manager = new ModelCacheManager(loggerMock.Object, _fileSystemMock.Object);
+  }
+
+  [Fact]
+  public void ClearCache_ShouldNotDeleteFiles_WhenDirectoryDoesNotExist()
+  {
+    _fileSystemMock.Setup(fs => fs.DirectoryExists(It.IsAny<string>())).Returns(false);
+    _manager.ClearCache();
+    _fileSystemMock.Verify(fs => fs.EnumerateFiles(It.IsAny<string>()), Times.Never);
+    _fileSystemMock.Verify(fs => fs.DeleteFile(It.IsAny<string>()), Times.Never);
+  }
+
+  [Fact]
+  public void ClearCache_ShouldDeleteFiles_WhenDirectoryExists()
+  {
+    var files = new List<string> { "file1.db", "file2.db" };
+    _fileSystemMock.Setup(fs => fs.DirectoryExists(It.IsAny<string>())).Returns(true);
+    _fileSystemMock.Setup(fs => fs.EnumerateFiles(It.IsAny<string>())).Returns(files);
+    foreach (var file in files)
+    {
+      _fileSystemMock.Setup(fs => fs.DeleteFile(file));
+    }
+    _manager.ClearCache();
+  }
+
+  [Fact]
+  public void ClearCache_ShouldLogWarning_WhenDeleteFileThrows()
+  {
+    var files = new List<string> { "file1.db" };
+    _fileSystemMock.Setup(fs => fs.DirectoryExists(It.IsAny<string>())).Returns(true);
+    _fileSystemMock.Setup(fs => fs.EnumerateFiles(It.IsAny<string>())).Returns(files);
+    _fileSystemMock.Setup(fs => fs.DeleteFile(It.IsAny<string>())).Throws<IOException>();
+    _manager.ClearCache();
+  }
+
+  [Fact]
+  public void GetCacheSize_ShouldReturnZero_WhenDirectoryDoesNotExist()
+  {
+    _fileSystemMock.Setup(fs => fs.DirectoryExists(It.IsAny<string>())).Returns(false);
+    var size = _manager.GetCacheSize();
+    size.Should().Be(0);
+  }
+
+  [Fact]
+  public void GetCacheSize_ShouldSumFileSizes()
+  {
+    var files = new List<string> { "file1.db", "file2.db" };
+    _fileSystemMock.Setup(fs => fs.DirectoryExists(It.IsAny<string>())).Returns(true);
+    _fileSystemMock.Setup(fs => fs.EnumerateFiles(It.IsAny<string>())).Returns(files);
+    _fileSystemMock.Setup(fs => fs.GetFileSize("file1.db")).Returns(10);
+    _fileSystemMock.Setup(fs => fs.GetFileSize("file2.db")).Returns(20);
+    var size = _manager.GetCacheSize();
+    size.Should().Be(30);
+  }
+
+  [Fact]
+  public void GetCacheSize_ShouldLogWarning_WhenGetFileSizeThrows()
+  {
+    var files = new List<string> { "file1.db" };
+    _fileSystemMock.Setup(fs => fs.DirectoryExists(It.IsAny<string>())).Returns(true);
+    _fileSystemMock.Setup(fs => fs.EnumerateFiles(It.IsAny<string>())).Returns(files);
+    _fileSystemMock.Setup(fs => fs.GetFileSize(It.IsAny<string>())).Throws<IOException>();
+    var size = _manager.GetCacheSize();
+    size.Should().Be(0);
+  }
+}

tests/Speckle.Sdk.Tests.Unit/Models/BaseTests.cs

@@ -213,7 +213,9 @@ public class BaseTests
   [Fact]
   public void CanShallowCopy()
   {
-    var sample = new SampleObject();
+    var sample = new SampleObject { id = "sampleId" };
+    dynamic x = sample;
+    x.test = "test";
     var copy = sample.ShallowCopy();
 
     var selectedMembers = DynamicBaseMemberType.Dynamic | DynamicBaseMemberType.Instance;

tests/Speckle.Sdk.Tests.Unit/Models/DynamicBaseTests.cs

@@ -0,0 +1,141 @@
+using FluentAssertions;
+using Microsoft.CSharp.RuntimeBinder;
+using Speckle.Sdk.Host;
+using Speckle.Sdk.Models;
+
+namespace Speckle.Sdk.Tests.Unit.Models;
+
+public class DynamicBaseTests
+{
+  public DynamicBaseTests()
+  {
+    TypeLoader.Reset();
+    TypeLoader.Initialize(typeof(Base).Assembly, typeof(BaseTests).Assembly);
+  }
+
+  [Fact]
+  public void Indexer_SetAndGet()
+  {
+    // Arrange
+    var dynamicBase = new DynamicBase();
+    var key = "testProperty";
+    var value = "testValue";
+
+    // Act
+    dynamicBase[key] = value;
+    var result = dynamicBase[key];
+
+    // Assert
+    result.Should().Be(value);
+  }
+
+  [Fact]
+  public void DynamicProperty_SetAndGet()
+  {
+    // Arrange
+    dynamic dynamicBase = new DynamicBase();
+    var value = "dynamicValue";
+
+    // Act
+    dynamicBase.dynamicProperty = value;
+    object result = dynamicBase.dynamicProperty;
+
+    // Assert
+    result.Should().Be(value);
+  }
+
+  [Fact]
+  public void GetMembers_Default()
+  {
+    // Arrange
+    dynamic dynamicBase = new DynamicBase();
+    dynamicBase.dynamicProp = "hello";
+
+    // Act
+    IDictionary<string, object?> members = dynamicBase.GetMembers();
+
+    // Assert
+    members.Should().ContainKey("dynamicProp");
+  }
+
+  [Fact]
+  public void GetMembers_Instance()
+  {
+    // Arrange
+    var dynamicBase = new TestDynamicBase();
+
+    // Act
+    var members = dynamicBase.GetMembers(DynamicBaseMemberType.Instance);
+
+    // Assert
+    members.Should().ContainKey(nameof(TestDynamicBase.InstanceProperty));
+    members.Should().NotContainKey("dynamicProp");
+  }
+
+  [Fact]
+  public void GetDynamicMemberNames()
+  {
+    // Arrange
+    dynamic dynamicBase = new DynamicBase();
+    dynamicBase.prop1 = 1;
+    dynamicBase.prop2 = "test";
+
+    // Act
+    IEnumerable<string> memberNames = dynamicBase.GetDynamicMemberNames();
+
+    // Assert
+    memberNames.Should().BeEquivalentTo(["DynamicPropertyKeys", "prop1", "prop2"]);
+  }
+
+  [Fact]
+  public void TryGetMember_Existing()
+  {
+    // Arrange
+    dynamic dynamicBase = new DynamicBase();
+    dynamicBase.existingProp = "I exist";
+
+    // Act
+    var result = dynamicBase.existingProp;
+
+    // Assert
+    ((object)result)
+      .Should()
+      .Be("I exist");
+  }
+
+  [Fact]
+  public void TryGetMember_NonExisting()
+  {
+    // Arrange
+    dynamic dynamicBase = new DynamicBase();
+
+    // Act
+    Action act = () =>
+    {
+      var result = dynamicBase.nonExistingProp;
+    };
+
+    // Assert
+    act.Should().Throw<RuntimeBinderException>();
+  }
+
+  [Fact]
+  public void TrySetMember()
+  {
+    // Arrange
+    dynamic dynamicBase = new DynamicBase();
+
+    // Act
+    dynamicBase.newProp = "newValue";
+
+    // Assert
+    ((object)dynamicBase.newProp)
+      .Should()
+      .Be("newValue");
+  }
+
+  private class TestDynamicBase : DynamicBase
+  {
+    public string InstanceProperty { get; set; } = "instance";
+  }
+}

tests/Speckle.Sdk.Tests.Unit/Transports/SQLiteTransport2Tests.cs

@@ -1,7 +1,7 @@
 using FluentAssertions;
 using Microsoft.Data.Sqlite;
+using Speckle.Sdk.Caching;
 using Speckle.Sdk.Common;
-using Speckle.Sdk.Serialisation.Utilities;
 using Speckle.Sdk.Transports;
 
 namespace Speckle.Sdk.Tests.Unit.Transports;
@@ -13,7 +13,7 @@ public sealed class SQLiteTransport2Tests : TransportTests, IDisposable
   private SQLiteTransport2? _sqlite;
 
   private static readonly string s_name = $"test-{Guid.NewGuid()}";
-  private static readonly string s_basePath = SqlitePaths.GetDBPath(s_name);
+  private static readonly string s_basePath = ModelCacheManager.GetDbPath(s_name);
 
   public SQLiteTransport2Tests()
   {