Entity Framework Support (#108)

Author: SebastianStehle

.github/workflows/test.yml

@@ -25,6 +25,7 @@ jobs:
           # Windows
           - build: win-x64
             os: windows-latest
+            test: --filter Category!=Docker
 
             # Linux
           - build: linux-x64
@@ -36,6 +37,7 @@ jobs:
           # macOS
           - build: macos-aarch64
             os: macos-latest
+            test: --filter Category!=Docker
 
     steps:
       - name: Checkout
@@ -63,6 +65,6 @@ jobs:
 
       - name: Run tests server
         run: |
-          dotnet test Tests/YDotNet.Tests.Server.Unit
+          dotnet test Tests/YDotNet.Tests.Server.Unit ${{ matrix.test }}
         env:
           RUST_BACKTRACE: 1

Demo/Callback.cs

@@ -5,15 +5,8 @@
 
 namespace Demo;
 
-public sealed class Callback : IDocumentCallback
+public sealed class Callback(ILogger<Callback> log) : IDocumentCallback
 {
-    private readonly ILogger<Callback> log;
-
-    public Callback(ILogger<Callback> log)
-    {
-        this.log = log;
-    }
-
     public ValueTask OnAwarenessUpdatedAsync(ClientAwarenessEvent @event)
     {
         log.LogInformation("Client {clientId} awareness changed.", @event.Context.ClientId);

Demo/Db/AppDbContext.cs

@@ -0,0 +1,13 @@
+using Microsoft.EntityFrameworkCore;
+using YDotNet.Server.EntityFramework;
+
+namespace Demo.Db;
+
+public class AppDbContext(DbContextOptions options) : DbContext(options)
+{
+    protected override void OnModelCreating(ModelBuilder modelBuilder)
+    {
+        modelBuilder.UseYDotNet();
+        base.OnModelCreating(modelBuilder);
+    }
+}

Demo/Db/DbInitializer.cs

@@ -0,0 +1,22 @@
+
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Storage;
+
+namespace Demo.Db;
+
+public class DbInitializer(IDbContextFactory<AppDbContext> dbContextFactory) : IHostedService
+{
+    public async Task StartAsync(CancellationToken cancellationToken)
+    {
+        await using var context = await dbContextFactory.CreateDbContextAsync(cancellationToken);
+
+        var creator = (RelationalDatabaseCreator)context.Database.GetService<IDatabaseCreator>();
+        await creator.EnsureCreatedAsync(cancellationToken);
+    }
+
+    public Task StopAsync(CancellationToken cancellationToken)
+    {
+        return Task.CompletedTask;
+    }
+}

Demo/Program.cs

@@ -1,6 +1,9 @@
+using Demo.Db;
+using Microsoft.EntityFrameworkCore;
 using MongoDB.Driver;
 using StackExchange.Redis;
 using YDotNet.Server;
+using YDotNet.Server.EntityFramework;
 using YDotNet.Server.MongoDB;
 
 namespace Demo;
@@ -50,6 +53,20 @@ public static void Main(string[] args)
                                 builder.Configuration["Storage:Redis:ConnectionString"]!);
                     });
 
+                    break;
+                }
+
+            case "Postgres":
+                {
+                    builder.Services.AddHostedService<DbInitializer>();
+                    builder.Services.AddDbContext<AppDbContext>(options =>
+                    {
+                        options.UseNpgsql(
+                            builder.Configuration["Storage:Postgres:ConnectionString"]!);
+                    });
+
+                    yDotNet.AddEntityFrameworkStorage<AppDbContext>();
+
                     break;
                 }
         }

Demo/appsettings.json

@@ -15,6 +15,9 @@
     },
     "Redis": {
       "ConnectionString": "localhost:6379"
+    },
+    "Postgres": {
+      "ConnectionString": "Host=localhost;Port=5432;Database=ydotnet;Username=postgres;Password=password"
     }
   }
 }

Directory.Build.props

@@ -11,7 +11,7 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-    <Version>0.4.1</Version>
+    <Version>0.4.2</Version>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">

Tests/YDotNet.Tests.Server.Unit/DelayedWriterTests.cs

@@ -1,8 +1,8 @@
+namespace YDotNet.Tests.Server.Unit;
+
 using NUnit.Framework;
 using YDotNet.Server.Internal;
 
-namespace YDotNet.Tests.Server.Unit;
-
 public class DelayedWriterTests
 {
     [Test]
@@ -81,6 +81,7 @@ public async Task WriteAfterDelayOnce()
         {
             sut.Ping();
         }
+
         await Task.Delay(300);
 
         // Assert

Tests/YDotNet.Tests.Server.Unit/DocumentContainerTests.cs

@@ -1,3 +1,5 @@
+namespace YDotNet.Tests.Server.Unit;
+
 using FakeItEasy;
 using Microsoft.Extensions.Logging;
 using NUnit.Framework;
@@ -6,8 +8,6 @@
 using YDotNet.Server.Internal;
 using YDotNet.Server.Storage;
 
-namespace YDotNet.Tests.Server.Unit;
-
 public class DocumentContainerTests
 {
     private readonly IDocumentStorage documentStorage = A.Fake<IDocumentStorage>();
@@ -31,7 +31,7 @@ await sut.ApplyUpdateReturnAsync(async doc =>
                 map.Insert(transaction, "key", Input.Double(42));
             }
 
-            await Task.Delay(100);
+            await Task.Delay(100).ConfigureAwait(false);
             return true;
         });
 
@@ -43,7 +43,12 @@ private DocumentContainer CreateSut(DocumentManagerOptions? options)
     {
         options ??= new DocumentManagerOptions();
 
-        return new DocumentContainer(name, documentStorage, documentCallback, documentManager, options,
+        return new DocumentContainer(
+            name,
+            documentStorage,
+            documentCallback,
+            documentManager,
+            options,
             A.Fake<ILogger>());
     }
 }

Tests/YDotNet.Tests.Server.Unit/DocumentStorageTests.cs

@@ -0,0 +1,60 @@
+namespace YDotNet.Tests.Server.Unit;
+
+using NUnit.Framework;
+using YDotNet.Server.Storage;
+
+public abstract class DocumentStorageTests
+{
+    protected abstract IDocumentStorage CreateSut();
+
+    [Test]
+    public async Task GetDocData()
+    {
+        // Arrange
+        var sut = CreateSut();
+
+        // Act
+        var received = await sut.GetDocAsync(Guid.NewGuid().ToString());
+
+        // Assert
+        Assert.That(received, Is.Null);
+    }
+
+    [Test]
+    public async Task InsertDocument()
+    {
+        // Arrange
+        var sut = CreateSut();
+
+        var docName = Guid.NewGuid().ToString();
+        var docData = new byte[] { 1, 2, 3, 4 };
+
+        // Act
+        await sut.StoreDocAsync(docName, docData);
+
+        // Assert
+        var received = await sut.GetDocAsync(docName);
+
+        Assert.That(received, Is.EqualTo(docData));
+    }
+
+    [Test]
+    public async Task UpdateDocument()
+    {
+        // Arrange
+        var sut = CreateSut();
+
+        var docName = Guid.NewGuid().ToString();
+        var docData1 = new byte[] { 1, 2, 3, 4 };
+        var docData2 = new byte[] { 5, 6, 7, 8 };
+
+        // Act
+        await sut.StoreDocAsync(docName, docData1);
+        await sut.StoreDocAsync(docName, docData2);
+
+        // Assert
+        var received = await sut.GetDocAsync(docName);
+
+        Assert.That(received, Is.EqualTo(docData2));
+    }
+}