Cleanup, first pass implementation of User, Project and Publisher collection event stream handlers

Author: Arlodotexe

src/IReadOnlyEntity.cs

@@ -5,13 +5,8 @@ namespace WindowsAppCommunity.Sdk;
 /// <summary>
 /// Represents a read-only entity with common properties and events.
 /// </summary>
-public interface IReadOnlyEntity : IReadOnlyConnectionsCollection, IReadOnlyLinksCollection, IReadOnlyImagesCollection
+public interface IReadOnlyEntity : IReadOnlyConnectionsCollection, IReadOnlyLinksCollection, IReadOnlyImagesCollection, IHasId
 {
-    /// <summary>
-    /// An Id corresponding to this object instance. This Id should be unique for the object, but identical across runs and environments.
-    /// </summary>
-    string Id { get; }
-
     /// <summary>
     /// The name of the entity.
     /// </summary>

src/IReadOnlyProject.cs

@@ -1,4 +1,6 @@
-namespace WindowsAppCommunity.Sdk;
+using OwlCore.ComponentModel;
+
+namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a project.
@@ -10,7 +12,7 @@ public interface IReadOnlyProject : IReadOnlyProject<IReadOnlyProjectCollection>
 /// <summary>
 /// Represents a project.
 /// </summary>
-public interface IReadOnlyProject<out TDependencyCollection> : IReadOnlyEntity, IReadOnlyImagesCollection, IReadOnlyUserRoleCollection, IReadOnlyAccentColor, IReadOnlyFeaturesCollection
+public interface IReadOnlyProject<out TDependencyCollection> : IReadOnlyEntity, IReadOnlyImagesCollection, IReadOnlyUserRoleCollection, IReadOnlyAccentColor, IReadOnlyFeaturesCollection, IHasId
     where TDependencyCollection : IReadOnlyProjectCollection<IReadOnlyProject>
 {
     /// <summary>

src/IReadOnlyProjectCollection.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using OwlCore.ComponentModel;
 
 namespace WindowsAppCommunity.Sdk;
 
@@ -12,7 +13,7 @@ public interface IReadOnlyProjectCollection : IReadOnlyProjectCollection<IReadOn
 /// <summary>
 /// Represents a collection of projects.
 /// </summary>
-public interface IReadOnlyProjectCollection<TProject>
+public interface IReadOnlyProjectCollection<TProject> : IHasId
     where TProject : IReadOnlyProject
 {
     /// <summary>

src/IReadOnlyPublisher.cs

@@ -1,4 +1,6 @@
-namespace WindowsAppCommunity.Sdk;
+using OwlCore.ComponentModel;
+
+namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a publisher, a collection of projects and collaborators who publish content to users.
@@ -10,7 +12,7 @@ public interface IReadOnlyPublisher : IReadOnlyPublisher<IReadOnlyPublisherColle
 /// <summary>
 /// Represents a publisher, a collection of projects and collaborators who publish content to users.
 /// </summary>
-public interface IReadOnlyPublisher<TPublisherCollection> : IReadOnlyEntity, IReadOnlyAccentColor, IReadOnlyUserRoleCollection, IReadOnlyProjectCollection
+public interface IReadOnlyPublisher<TPublisherCollection> : IReadOnlyEntity, IReadOnlyAccentColor, IReadOnlyUserRoleCollection, IReadOnlyProjectCollection, IHasId
     where TPublisherCollection : IReadOnlyPublisherCollection<IReadOnlyPublisher>
 {
     /// <summary>

src/IReadOnlyPublisherCollection.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using OwlCore.ComponentModel;
 
 namespace WindowsAppCommunity.Sdk;
 
@@ -12,7 +13,7 @@ public interface IReadOnlyPublisherCollection : IReadOnlyPublisherCollection<IRe
 /// <summary>
 /// Represents a collection of publishers that can be read but not modified.
 /// </summary>
-public interface IReadOnlyPublisherCollection<TPublisher>
+public interface IReadOnlyPublisherCollection<TPublisher> : IHasId
     where TPublisher : IReadOnlyPublisher
 {
     /// <summary>

src/IReadOnlyUser.cs

@@ -1,8 +1,10 @@
-namespace WindowsAppCommunity.Sdk;
+using OwlCore.ComponentModel;
+
+namespace WindowsAppCommunity.Sdk;
 
 /// <summary>
 /// Represents a user.
 /// </summary>
-public interface IReadOnlyUser : IReadOnlyEntity, IReadOnlyPublisherRoleCollection, IReadOnlyProjectRoleCollection
+public interface IReadOnlyUser : IReadOnlyEntity, IReadOnlyPublisherRoleCollection, IReadOnlyProjectRoleCollection, IHasId
 {
 }

src/IReadOnlyUserCollection.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using OwlCore.ComponentModel;
 
 namespace WindowsAppCommunity.Sdk;
 
@@ -13,7 +14,7 @@ public interface IReadOnlyUserCollection : IReadOnlyUserCollection<IReadOnlyUser
 /// Represents a collection of users with a corresponding role that can be modified.
 /// </summary>
 /// <typeparam name="TUser">The type of user in this collection.</typeparam>
-public interface IReadOnlyUserCollection<out TUser>
+public interface IReadOnlyUserCollection<out TUser> : IHasId
     where TUser : IReadOnlyUser
 {
     /// <summary>

src/Models/IUserRoleCollection.cs

@@ -1,4 +1,3 @@
-using System.Collections.Generic;
 using Ipfs;
 
 namespace WindowsAppCommunity.Sdk.Models;

src/Models/Role.cs

@@ -1,4 +1,3 @@
-using Newtonsoft.Json;
 using OwlCore.Storage;
 
 namespace WindowsAppCommunity.Sdk.Models;

src/Nomad/ModifiableProjectCollection.cs

@@ -0,0 +1,99 @@
+using System.Collections.Generic;
+using System.Linq;
+using Ipfs;
+using OwlCore.Nomad;
+using OwlCore.Nomad.Kubo;
+using OwlCore.Nomad.Kubo.Events;
+
+namespace WindowsAppCommunity.Sdk.Nomad;
+
+/// <summary>
+/// A modifiable handler for roaming project collection data.
+/// </summary>
+public class ModifiableProjectCollection : NomadKuboEventStreamHandler<ValueUpdateEvent>, IModifiableProjectCollection<IReadOnlyProject>
+{
+    /// <inheritdoc/>
+    public required string Id { get; init; }
+
+    /// <inheritdoc/>
+    public required ReadOnlyProjectCollection Inner { get; init; }
+
+    /// <inheritdoc/>
+    public event EventHandler<IReadOnlyProject[]>? ProjectsAdded;
+
+    /// <inheritdoc/>
+    public event EventHandler<IReadOnlyProject[]>? ProjectsRemoved;
+
+    /// <inheritdoc/>
+    public IAsyncEnumerable<IReadOnlyProject> GetProjectsAsync(CancellationToken cancellationToken) => Inner.GetProjectsAsync(cancellationToken);
+
+    /// <inheritdoc/>
+    public async Task AddProjectAsync(IReadOnlyProject project, CancellationToken cancellationToken)
+    {
+        var valueCid = await Client.Dag.PutAsync(project.Id, pin: KuboOptions.ShouldPin, cancel: cancellationToken);
+
+        var updateEvent = new ValueUpdateEvent(Key: null, Value: (DagCid)valueCid, false);
+
+        var appendedEntry = await AppendNewEntryAsync(targetId: Id, eventId: nameof(AddProjectAsync), updateEvent, DateTime.UtcNow, cancellationToken);
+        await ApplyAddProjectEntryAsync(appendedEntry, updateEvent, project, cancellationToken);
+
+        EventStreamPosition = appendedEntry;
+    }
+
+    /// <inheritdoc/>
+    public async Task RemoveProjectAsync(IReadOnlyProject project, CancellationToken cancellationToken)
+    {
+        var valueCid = await Client.Dag.PutAsync(project.Id, pin: KuboOptions.ShouldPin, cancel: cancellationToken);
+
+        var updateEvent = new ValueUpdateEvent(Key: null, Value: (DagCid)valueCid, false);
+
+        var appendedEntry = await AppendNewEntryAsync(targetId: Id, eventId: nameof(RemoveProjectAsync), updateEvent, DateTime.UtcNow, cancellationToken);
+        await ApplyRemoveProjectEntryAsync(appendedEntry, updateEvent, project, cancellationToken);
+
+        EventStreamPosition = appendedEntry;
+    }
+
+    /// <inheritdoc/>
+    public override async Task ApplyEntryUpdateAsync(EventStreamEntry<DagCid> streamEntry, ValueUpdateEvent updateEvent, CancellationToken cancellationToken)
+    {
+        switch (streamEntry.EventId)
+        {
+            case nameof(AddProjectAsync):
+                // TODO: Needs project repository
+                ReadOnlyProject addedProject = null!;
+                await ApplyAddProjectEntryAsync(streamEntry, updateEvent, addedProject, cancellationToken);
+                break;
+            case nameof(RemoveProjectAsync):
+                // TODO: Needs project repository
+                ReadOnlyProject removedProject = null!;
+                await ApplyRemoveProjectEntryAsync(streamEntry, updateEvent, removedProject, cancellationToken);
+                break;
+            default:
+                throw new InvalidOperationException($"Unknown event id: {streamEntry.EventId}");
+        }
+    }
+
+    /// <inheritdoc/>
+    public Task ApplyAddProjectEntryAsync(EventStreamEntry<DagCid> streamEntry, ValueUpdateEvent updateEvent, IReadOnlyProject project, CancellationToken cancellationToken)
+    {
+        Inner.Inner.Projects = [.. Inner.Inner.Projects, project.Id];
+        ProjectsAdded?.Invoke(this, [project]);
+        return Task.CompletedTask;
+    }
+
+    /// <inheritdoc/>
+    public Task ApplyRemoveProjectEntryAsync(EventStreamEntry<DagCid> streamEntry, ValueUpdateEvent updateEvent, IReadOnlyProject project, CancellationToken cancellationToken)
+    {
+        Inner.Inner.Projects = [.. Inner.Inner.Projects.Where(id => id != project.Id)];
+        ProjectsRemoved?.Invoke(this, [project]);
+        return Task.CompletedTask;
+
+    }
+
+    /// <inheritdoc/>
+    public override Task ResetEventStreamPositionAsync(CancellationToken cancellationToken)
+    {
+        Inner.Inner.Projects = [];
+        return Task.CompletedTask;
+    }
+}