Allow todo lists to have different names than id's - change registry grain to be state-based journaled

egil · egil · commit ef769cdd72bc · 2025-03-17T13:39:10.000Z
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Layout/NavBar.razor b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Layout/NavBar.razor
@@ -5,11 +5,11 @@
                 <i class="bi bi-house-door me-2"></i> Home
             </NavLink>
         </li>
-        @foreach (var listId in TodoLists)
+        @foreach (var list in TodoLists)
         {
             <li class="nav-item">
-                <NavLink class="nav-link" href="@($"todolist/{listId}")">
-                    <i class="bi bi-list-task me-1"></i> @listId
+                <NavLink class="nav-link" href="@($"todolist/{list.Id}")">
+                    <i class="bi bi-list-task me-1"></i> @list.Name
                 </NavLink>
             </li>
         }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Layout/NavBar.razor.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Layout/NavBar.razor.cs
@@ -8,11 +8,10 @@ public partial class NavBar(TodoListService todoListService) : ITodoListRegistry
 {
     private IDisposable? subscription;
 
-    private ImmutableArray<string> TodoLists { get; set; } = [];
+    private ImmutableArray<TodoListReference> TodoLists { get; set; } = [];
 
     protected override async Task OnInitializedAsync()
     {
-        TodoLists = await todoListService.GetAllTodoListsAsync();
         subscription = await todoListService.SubscribeAsync(this);
     }
 
@@ -21,7 +20,7 @@ public void Dispose()
         subscription?.Dispose();
     }
 
-    async Task ITodoListRegistryObserver.OnTodoListsChanged(ImmutableArray<string> todoLists) => await InvokeAsync(() =>
+    async Task ITodoListRegistryObserver.OnTodoListsChanged(ImmutableArray<TodoListReference> todoLists) => await InvokeAsync(() =>
     {
         TodoLists = todoLists;
         StateHasChanged();
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Pages/HomePage.razor b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Pages/HomePage.razor
@@ -14,10 +14,10 @@
     </div>
 
     <div class="list-group">
-        @foreach (var listId in todoLists)
+        @foreach (var list in TodoLists)
         {
-            <a href="/todolist/@listId" class="list-group-item list-group-item-action">
-                @listId
+            <a href="/todolist/@(list.Id)" class="list-group-item list-group-item-action">
+                @list.Name
             </a>
         }
     </div>
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Pages/HomePage.razor.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Components/Pages/HomePage.razor.cs
@@ -1,38 +1,40 @@
 ﻿using System.Collections.Immutable;
+using JournaledTodoList.WebApp.Grains;
 using JournaledTodoList.WebApp.Services;
 
 namespace JournaledTodoList.WebApp.Components.Pages;
 
-public partial class HomePage(TodoListService todoListService)
+public partial class HomePage(TodoListService todoListService) : ITodoListRegistryObserver, IDisposable
 {
+    private IDisposable? subscription;
     private string newListName = "";
-    private ImmutableArray<string> todoLists = [];
+
+    private ImmutableArray<TodoListReference> TodoLists { get; set; } = [];
 
     protected override async Task OnInitializedAsync()
     {
-        todoLists = await todoListService.GetAllTodoListsAsync();
-        await CreateNewList("Default");
+        subscription = await todoListService.SubscribeAsync(this);
     }
 
+    public void Dispose()
+    {
+        subscription?.Dispose();
+    }
+
+    async Task ITodoListRegistryObserver.OnTodoListsChanged(ImmutableArray<TodoListReference> todoLists) => await InvokeAsync(() =>
+    {
+        TodoLists = todoLists;
+        StateHasChanged();
+    });
+
     private async Task CreateNewList(string listName)
     {
-        var normalizedName = NormalizeListName(listName);
-        if (string.IsNullOrWhiteSpace(normalizedName) || todoLists.Contains(normalizedName))
+        if (string.IsNullOrWhiteSpace(listName) || TodoLists.Any(x => x.Name == listName))
         {
             return;
         }
 
-        await todoListService.CreateTodoListAsync(normalizedName);
-        todoLists = await todoListService.GetAllTodoListsAsync();
+        await todoListService.CreateTodoListAsync(listName);
         newListName = "";
     }
-
-    private static string NormalizeListName(string name)
-    {
-        // Replace spaces and special characters to ensure valid URL
-        return name.Trim()
-                  .Replace(" ", "-")
-                  .Replace("/", "-")
-                  .Replace("\\", "-");
-    }
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Constants.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Constants.cs
@@ -0,0 +1,4 @@
+﻿public static class Constants
+{
+    public const string StateStorageProviderName = "StateStorage";
+}
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemAdded.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemAdded.cs
@@ -2,7 +2,7 @@
 
 [GenerateSerializer, Immutable]
 public record class TodoItemAdded(int ItemId, DateTimeOffset Timestamp, string Title)
-    : TodoListEvent(ItemId, Timestamp)
+    : TodoListEvent(Timestamp)
 {
     public override string GetDescription() => $"Added item {ItemId}: {Title}";
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemRemoved.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemRemoved.cs
@@ -1,7 +1,7 @@
 ﻿namespace JournaledTodoList.WebApp.Grains.Events;
 
 [GenerateSerializer, Immutable]
-public record class TodoItemRemoved(int ItemId, DateTimeOffset Timestamp) : TodoListEvent(ItemId, Timestamp)
+public record class TodoItemRemoved(int ItemId, DateTimeOffset Timestamp) : TodoListEvent(Timestamp)
 {
     public override string GetDescription() => $"Removed item {ItemId}";
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemToggled.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemToggled.cs
@@ -1,7 +1,7 @@
 ﻿namespace JournaledTodoList.WebApp.Grains.Events;
 
 [GenerateSerializer, Immutable]
-public record class TodoItemToggled(int ItemId, DateTimeOffset Timestamp) : TodoListEvent(ItemId, Timestamp)
+public record class TodoItemToggled(int ItemId, DateTimeOffset Timestamp) : TodoListEvent(Timestamp)
 {
     public override string GetDescription() => $"Toggled completion status of item {ItemId}";
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemUpdated.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoItemUpdated.cs
@@ -1,7 +1,7 @@
 ﻿namespace JournaledTodoList.WebApp.Grains.Events;
 
 [GenerateSerializer, Immutable]
-public record class TodoItemUpdated(int ItemId, DateTimeOffset Timestamp, string Title) : TodoListEvent(ItemId, Timestamp)
+public record class TodoItemUpdated(int ItemId, DateTimeOffset Timestamp, string Title) : TodoListEvent(Timestamp)
 {
     public override string GetDescription() => $"Updated item {ItemId}: {Title}";
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoListEvent.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoListEvent.cs
@@ -1,7 +1,7 @@
 ﻿namespace JournaledTodoList.WebApp.Grains.Events;
 
 [GenerateSerializer, Immutable]
-public abstract record class TodoListEvent(int ItemId, DateTimeOffset Timestamp)
+public abstract record class TodoListEvent(DateTimeOffset Timestamp)
 {
     public abstract string GetDescription();
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoListNameChanged.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/Events/TodoListNameChanged.cs
@@ -0,0 +1,7 @@
+﻿namespace JournaledTodoList.WebApp.Grains.Events;
+
+[GenerateSerializer, Immutable]
+public record class TodoListNameChanged(string Name, DateTimeOffset Timestamp) : TodoListEvent(Timestamp)
+{
+    public override string GetDescription() => $"Todo list name changed to {Name}";
+}
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/ITodoListGrain.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/ITodoListGrain.cs
@@ -6,10 +6,18 @@ namespace JournaledTodoList.WebApp.Grains;
 public interface ITodoListGrain : IGrainWithStringKey
 {
     Task<TodoList> GetTodoListAsync();
+
     Task<TodoList?> GetTodoListAtTimestampAsync(DateTimeOffset timestamp);
+
     Task AddTodoItemAsync(string title);
+
     Task UpdateTodoItemAsync(int id, string title);
+
     Task ToggleTodoItemAsync(int id);
+
     Task RemoveTodoItemAsync(int id);
+
+    Task SetNameAsync(string listName);
+
     Task<ImmutableArray<TodoListEvent>> GetHistoryAsync();
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/ITodoListRegistryGrain.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/ITodoListRegistryGrain.cs
@@ -4,9 +4,9 @@ namespace JournaledTodoList.WebApp.Grains;
 
 public interface ITodoListRegistryGrain : IGrainWithStringKey
 {
-    Task RegisterTodoListAsync(string todoListId);
+    Task RegisterTodoListAsync(TodoListReference todoListReference);
 
-    Task<ImmutableArray<string>> GetAllTodoListsAsync();
+    Task<ImmutableArray<TodoListReference>> GetAllTodoListsAsync();
 
     Task Subscribe(ITodoListRegistryObserver observer);
 
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/ITodoListRegistryObserver.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/ITodoListRegistryObserver.cs
@@ -1,8 +1,8 @@
-using System.Collections.Immutable;
+﻿using System.Collections.Immutable;
 
 namespace JournaledTodoList.WebApp.Grains;
 
 public interface ITodoListRegistryObserver : IGrainObserver
 {
-    Task OnTodoListsChanged(ImmutableArray<string> todoLists);
+    Task OnTodoListsChanged(ImmutableArray<TodoListReference> todoLists);
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/TodoListGrain.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/TodoListGrain.cs
@@ -6,35 +6,29 @@ namespace JournaledTodoList.WebApp.Grains;
 
 public sealed class TodoListGrain : JournaledGrain<TodoListGrain.TodoListProjection, TodoListEvent>, ITodoListGrain
 {
-    public override async Task OnActivateAsync(CancellationToken cancellationToken)
+    public async Task<ImmutableArray<TodoListEvent>> GetHistoryAsync()
     {
-        var registry = GrainFactory.GetGrain<ITodoListRegistryGrain>("registry");
-        await registry.RegisterTodoListAsync(this.GetPrimaryKeyString());
+        var events = await RetrieveConfirmedEvents(0, Version);
+        return events.ToImmutableArray();
     }
 
     public async Task<TodoList?> GetTodoListAtTimestampAsync(DateTimeOffset timestamp)
     {
         // Get all events up to the current version
-        var allEvents = await RetrieveConfirmedEvents(0, Version);
+        var allEvents = await GetHistoryAsync();
 
         // Create a fresh projection and apply the filtered events
         var historicalProjection = new TodoListProjection();
         foreach (var evt in allEvents.Where(e => e.Timestamp <= timestamp))
         {
-            switch (evt)
-            {
-                case TodoItemAdded added: historicalProjection.Apply(added); break;
-                case TodoItemUpdated updated: historicalProjection.Apply(updated); break;
-                case TodoItemToggled toggled: historicalProjection.Apply(toggled); break;
-                case TodoItemRemoved removed: historicalProjection.Apply(removed); break;
-            }
+            TransitionState(historicalProjection, evt);
         }
 
-        // Return the historical state
+        // Only return a TodoList if there were events that matched the timestamp.
         return historicalProjection.Timestamp > DateTimeOffset.MinValue
             ? new TodoList(
                 Name: this.GetPrimaryKeyString(),
-                Items: historicalProjection.Items.Values.ToImmutableArray(),
+                Items: historicalProjection.Items.Values.OrderBy(x => x.Id).ToImmutableArray(),
                 Timestamp: historicalProjection.Timestamp)
             : null;
     }
@@ -46,7 +40,7 @@ public async Task<TodoList> GetTodoListAsync()
 
         var list = new TodoList(
             Name: this.GetPrimaryKeyString(),
-            Items: State.Items.Values.ToImmutableArray(),
+            Items: State.Items.Values.OrderBy(x => x.Id).ToImmutableArray(),
             Timestamp: State.Timestamp);
 
         return list;
@@ -84,10 +78,17 @@ public async Task RemoveTodoItemAsync(int id)
         await ConfirmEvents();
     }
 
-    public async Task<ImmutableArray<TodoListEvent>> GetHistoryAsync()
+    public async Task SetNameAsync(string listName)
     {
-        var events = await RetrieveConfirmedEvents(0, Version);
-        return events.ToImmutableArray();
+        var evt = new TodoListNameChanged(listName, DateTimeOffset.UtcNow);
+        RaiseEvent(evt);
+        await ConfirmEvents();
+
+        // Publish list with new name to todo list registry.
+        // The registry only cares about the id and name of the list,
+        // so this is the only place where we need to interact with the registry.
+        var registry = GrainFactory.GetGrain<ITodoListRegistryGrain>("registry");
+        await registry.RegisterTodoListAsync(new TodoListReference(this.GetPrimaryKeyString(), listName));
     }
 
     /// <summary>
@@ -100,6 +101,8 @@ public sealed class TodoListProjection
 
         public DateTimeOffset Timestamp { get; set; } = DateTimeOffset.MinValue;
 
+        public string Name { get; set; } = string.Empty;
+
         public void Apply(TodoItemAdded added)
         {
             Items.Add(added.ItemId, new TodoItem(added.ItemId, added.Title, false));
@@ -129,5 +132,11 @@ public void Apply(TodoItemRemoved removed)
             Items.Remove(removed.ItemId);
             Timestamp = removed.Timestamp;
         }
+
+        public void Apply(TodoListNameChanged nameChanged)
+        {
+            Name = nameChanged.Name;
+            Timestamp = nameChanged.Timestamp;
+        }
     }
 }
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/TodoListReference.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/TodoListReference.cs
@@ -0,0 +1,4 @@
+﻿namespace JournaledTodoList.WebApp.Grains;
+
+[GenerateSerializer, Immutable]
+public record class TodoListReference(string Id, string Name);
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/TodoListRegistryGrain.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Grains/TodoListRegistryGrain.cs
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Program.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Program.cs
diff --git a/orleans/JournaledTodoList/JournaledTodoList.WebApp/Services/TodoListService.cs b/orleans/JournaledTodoList/JournaledTodoList.WebApp/Services/TodoListService.cs

Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,10 @@ public partial class NavBar(TodoListService todoListService) : ITodoListRegistry`
`8`	`8`	`{`
`9`	`9`	`private IDisposable? subscription;`
`10`	`10`
`11`		`- private ImmutableArray<string> TodoLists { get; set; } = [];`
	`11`	`+ private ImmutableArray<TodoListReference> TodoLists { get; set; } = [];`
`12`	`12`
`13`	`13`	`protected override async Task OnInitializedAsync()`
`14`	`14`	`{`
`15`		`- TodoLists = await todoListService.GetAllTodoListsAsync();`
`16`	`15`	`subscription = await todoListService.SubscribeAsync(this);`
`17`	`16`	`}`
`18`	`17`
`@@ -21,7 +20,7 @@ public void Dispose()`
`21`	`20`	`subscription?.Dispose();`
`22`	`21`	`}`
`23`	`22`
`24`		`- async Task ITodoListRegistryObserver.OnTodoListsChanged(ImmutableArray<string> todoLists) => await InvokeAsync(() =>`
	`23`	`+ async Task ITodoListRegistryObserver.OnTodoListsChanged(ImmutableArray<TodoListReference> todoLists) => await InvokeAsync(() =>`
`25`	`24`	`{`
`26`	`25`	`TodoLists = todoLists;`
`27`	`26`	`StateHasChanged();`
Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,10 @@`
`14`	`14`	`</div>`
`15`	`15`
`16`	`16`	`<div class="list-group">`
`17`		`- @foreach (var listId in todoLists)`
	`17`	`+ @foreach (var list in TodoLists)`
`18`	`18`	`{`
`19`		`- <a href="/todolist/@listId" class="list-group-item list-group-item-action">`
`20`		`- @listId`
	`19`	`+ <a href="/todolist/@(list.Id)" class="list-group-item list-group-item-action">`
	`20`	`+ @list.Name`
`21`	`21`	`</a>`
`22`	`22`	`}`
`23`	`23`	`</div>`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +public static class Constants
 +{
 +    public const string StateStorageProviderName = "StateStorage";
 +}
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`[GenerateSerializer, Immutable]`
`4`	`4`	`public record class TodoItemAdded(int ItemId, DateTimeOffset Timestamp, string Title)`
`5`		`- : TodoListEvent(ItemId, Timestamp)`
	`5`	`+ : TodoListEvent(Timestamp)`
`6`	`6`	`{`
`7`	`7`	`public override string GetDescription() => $"Added item {ItemId}: {Title}";`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`namespace JournaledTodoList.WebApp.Grains.Events;`
`2`	`2`
`3`	`3`	`[GenerateSerializer, Immutable]`
`4`		`-public record class TodoItemRemoved(int ItemId, DateTimeOffset Timestamp) : TodoListEvent(ItemId, Timestamp)`
	`4`	`+public record class TodoItemRemoved(int ItemId, DateTimeOffset Timestamp) : TodoListEvent(Timestamp)`
`5`	`5`	`{`
`6`	`6`	`public override string GetDescription() => $"Removed item {ItemId}";`
`7`	`7`	`}`