Auto cleanup.

Demo/Callback.cs

@@ -14,6 +14,18 @@ public Callback(ILogger<Callback> log)
         this.log = log;
     }
 
+    public ValueTask OnAwarenessUpdatedAsync(ClientAwarenessEvent @event)
+    {
+        log.LogInformation("Client {clientId} awareness changed.", @event.Context.ClientId);
+        return default;
+    }
+
+    public ValueTask OnClientDisconnectedAsync(ClientDisconnectedEvent @event)
+    {
+        log.LogInformation("Client {clientId} disconnected.", @event.Context.ClientId);
+        return default;
+    }
+
     public ValueTask OnDocumentLoadedAsync(DocumentLoadEvent @event)
     {
         if (@event.Context.DocumentName == "notifications")
@@ -69,6 +81,7 @@ await @event.Source.UpdateDocAsync(notificationCtx, (doc) =>
             {
                 List<Notification> notifications;
 
+                // Keep the transaction open as short as possible.
                 using (var transaction = @event.Document.ReadTransaction())
                 {
                     notifications = newNotificationsRaw.Select(x => x.To<Notification>(transaction)).ToList();
@@ -78,7 +91,8 @@ await @event.Source.UpdateDocAsync(notificationCtx, (doc) =>
 
                 notifications = notifications.Select(x => new Notification { Text = $"You got the follow message: {x.Text}" }).ToList();
 
-                using (var transaction = doc.WriteTransaction() ?? throw new InvalidOperationException("Failed to open transaction."))
+                // Keep the transaction open as short as possible.
+                using (var transaction = doc.WriteTransaction())
                 {
                     array.InsertRange(transaction, array.Length, notifications.Select(x => x.ToInput()).ToArray());
                 }

Demo/Client/src/components/Awareness.tsx

@@ -29,6 +29,6 @@ export const Awareness = () => {
     }, [awareness]);
 
     return (
-        <Input type='textarea' value={JSON.stringify(state, undefined, 2)} />
+        <Input type='textarea' readOnly value={JSON.stringify(state, undefined, 2)} />
     );
 };

Demo/Client/src/components/Chat.tsx

@@ -63,7 +63,7 @@ export const Chat = ({ isReadonly }: { isReadonly: boolean }) => {
             </div>
 
             {!isReadonly &&
-                <Row noGutters>
+                <Row className='gap-0'>
                     <Col>
                         <Input value={text} onChange={_setText}></Input>
                     </Col>

Demo/Client/src/components/Increment.tsx

@@ -9,7 +9,7 @@ export const Increment = () => {
 
     React.useEffect(() => {
         const handler = () => {
-            setState(map.get('value') || 0);
+            setState(map.get('value') as number || 0);
         };
 
         handler();
@@ -35,7 +35,7 @@ export const Increment = () => {
     };
 
     return (
-        <Row noGutters>
+        <Row className='gap-0'>
             <Col xs='auto'>
                 <Button onClick={_decrement}>-1</Button>
             </Col>

Demo/Client/src/components/YjsMonacoEditor.tsx

@@ -21,9 +21,7 @@ export const YjsMonacoEditor = () => {
 
     return (
         <div>
-            <MonacoEditor
-                editorDidMount={(e) => _onEditorDidMount(e)}
-            />
+            <MonacoEditor editorDidMount={(e) => _onEditorDidMount(e)} />
         </div>
     );
 };

Demo/Program.cs

@@ -15,6 +15,7 @@ public static void Main(string[] args)
 
         var yDotNet =
             builder.Services.AddYDotNet()
+                .AutoCleanup()
                 .AddCallback<Callback>()
                 .AddWebSockets();
 

Directory.Build.props

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

YDotNet.Server.MongoDB/MongoDocumentStorage.cs

@@ -32,7 +32,7 @@ await collection.Indexes.CreateOneAsync(
                 Builders<DocumentEntity>.IndexKeys.Ascending(x => x.Expiration),
                 new CreateIndexOptions
                 {
-                    ExpireAfter = TimeSpan.Zero
+                    ExpireAfter = TimeSpan.Zero,
                 }),
             cancellationToken: cancellationToken).ConfigureAwait(false);
     }

YDotNet.Server.WebSockets/WebSocketDecoder.cs

@@ -16,7 +16,7 @@ public WebSocketDecoder(WebSocket webSocket)
         this.webSocket = webSocket;
     }
 
-    public bool CanRead { get; set; } = true;
+    public bool CanRead { get; private set; } = true;
 
     public bool HasMore => bufferIndex < bufferLength;
 
@@ -61,7 +61,7 @@ private async Task ReadIfEndOfBufferReachedAsync(CancellationToken ct)
             if (received.CloseStatus != null)
             {
                 CanRead = false;
-                throw new InvalidOperationException("Socket is already closed.");
+                throw new WebSocketException("Socket is already closed.");
             }
 
             bufferLength = received.Count;

YDotNet.Server/CleanupOptions.cs

@@ -0,0 +1,8 @@
+namespace YDotNet.Server;
+
+public sealed class CleanupOptions
+{
+    public TimeSpan Interval { get; set; } = TimeSpan.FromMinutes(1);
+
+    public TimeSpan LogWaitTime { get; set; } = TimeSpan.FromMinutes(10);
+}

YDotNet.Server/DefaultDocumentCleaner.cs

@@ -0,0 +1,54 @@
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+
+namespace YDotNet.Server;
+
+internal class DefaultDocumentCleaner : BackgroundService
+{
+    private readonly IDocumentManager documentManager;
+    private readonly ILogger<DefaultDocumentCleaner> logger;
+    private readonly CleanupOptions options;
+    private DateTime lastLogging;
+
+    public Func<DateTime> Clock { get; } = () => DateTime.UtcNow;
+
+    public DefaultDocumentCleaner(IDocumentManager documentManager, IOptions<CleanupOptions> options, ILogger<DefaultDocumentCleaner> logger)
+    {
+        this.documentManager = documentManager;
+        this.logger = logger;
+        this.options = options.Value;
+    }
+
+    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
+    {
+        var timer = new PeriodicTimer(options.Interval);
+
+        while (await timer.WaitForNextTickAsync(stoppingToken).ConfigureAwait(false))
+        {
+            try
+            {
+                await documentManager.CleanupAsync(stoppingToken).ConfigureAwait(false);
+            }
+            catch (OperationCanceledException)
+            {
+                // This is an expected exception when the process stops. There is no good reason to handle that.
+            }
+            catch (Exception ex)
+            {
+                var now = Clock();
+
+                var timeSinceLastLogging = now - lastLogging;
+                // We run this loop very often. If there is an exception, it could flood the log with duplicate log entries.
+                // Therefore use a wait time between two log calls.
+                if (timeSinceLastLogging < options.LogWaitTime)
+                {
+                    return;
+                }
+
+                logger.LogError(ex, "Failed to cleanup document manager.");
+                lastLogging = now;
+            }
+        }
+    }
+}

YDotNet.Server/DefaultDocumentManager.cs

@@ -76,7 +76,7 @@ public async ValueTask<UpdateResult> ApplyUpdateAsync(DocumentContext context, b
         {
             var result = new UpdateResult
             {
-                Diff = stateDiff
+                Diff = stateDiff,
             };
 
             using (var transaction = doc.WriteTransactionOrThrow())
@@ -150,6 +150,7 @@ await callback.OnClientDisconnectedAsync(new ClientDisconnectedEvent
             {
                 Context = context,
                 Source = this,
+                Reason = DisconnectReason.Disconnect,
             }).ConfigureAwait(false);
         }
     }
@@ -163,16 +164,19 @@ await callback.OnClientDisconnectedAsync(new ClientDisconnectedEvent
             {
                 Context = new DocumentContext(documentName, clientId),
                 Source = this,
+                Reason = DisconnectReason.Cleanup,
             }).ConfigureAwait(false);
         }
 
         cache.RemoveEvictedItems();
     }
 
-    public ValueTask<IReadOnlyDictionary<ulong, ConnectedUser>> GetAwarenessAsync(
+    public async ValueTask<IReadOnlyDictionary<ulong, ConnectedUser>> GetAwarenessAsync(
         DocumentContext context,
         CancellationToken ct = default)
     {
-        return new ValueTask<IReadOnlyDictionary<ulong, ConnectedUser>>(users.GetUsers(context.DocumentName));
+        await CleanupAsync(default).ConfigureAwait(false);
+
+        return users.GetUsers(context.DocumentName);
     }
 }

YDotNet.Server/Events.cs

@@ -30,6 +30,7 @@ public sealed class DocumentChangedEvent : DocumentChangeEvent
 
 public sealed class ClientDisconnectedEvent : DocumentEvent
 {
+    required public DisconnectReason Reason { get; init; }
 }
 
 public sealed class ClientAwarenessEvent : DocumentEvent
@@ -38,3 +39,9 @@ public sealed class ClientAwarenessEvent : DocumentEvent
 
     required public ulong ClientClock { get; set; }
 }
+
+public enum DisconnectReason
+{
+    Disconnect,
+    Cleanup,
+}

YDotNet.Server/ServiceExtensions.cs

@@ -18,7 +18,7 @@ public static YDotnetRegistration AddYDotNet(this IServiceCollection services)
 
         return new YDotnetRegistration
         {
-            Services = services
+            Services = services,
         };
     }
 
@@ -28,6 +28,13 @@ public static YDotnetRegistration AddCallback<T>(this YDotnetRegistration regist
         registration.Services.AddSingleton<IDocumentCallback, T>();
         return registration;
     }
+
+    public static YDotnetRegistration AutoCleanup(this YDotnetRegistration registration, Action<CleanupOptions>? configure = null)
+    {
+        registration.Services.Configure(configure ?? (x => { }));
+        registration.Services.AddSingleton<IHostedService, DefaultDocumentCleaner>();
+        return registration;
+    }
 }
 
 #pragma warning disable MA0048 // File name must match type name

YDotNet/Document/Cells/OutputTag.cs

@@ -84,5 +84,5 @@ public enum OutputTag
     /// <summary>
     ///     Represents a cell with an <see cref="YDotNet.Document.Doc" /> value.
     /// </summary>
-    Doc = 7
+    Doc = 7,
 }

YDotNet/Document/Options/DocEncoding.cs

@@ -21,5 +21,5 @@ public enum DocEncoding
     /// <summary>
     ///     Compute editable strings length and offset using UTF-32 (Unicode) code points number.
     /// </summary>
-    Utf32 = 2
+    Utf32 = 2,
 }

YDotNet/Document/Options/DocOptions.cs

@@ -104,7 +104,7 @@ internal DocOptionsNative ToNative()
             Encoding = (byte)Encoding,
             SkipGc = (byte)(SkipGarbageCollection ? 1 : 0),
             AutoLoad = (byte)(AutoLoad ? 1 : 0),
-            ShouldLoad = (byte)(ShouldLoad ? 1 : 0)
+            ShouldLoad = (byte)(ShouldLoad ? 1 : 0),
         };
     }
 }

YDotNet/Document/StickyIndexes/StickyAssociationType.cs

@@ -24,5 +24,5 @@ public enum StickyAssociationType : sbyte
     /// <summary>
     ///     The corresponding <see cref="StickyIndex" /> points to space before the referenced element.
     /// </summary>
-    Before = -1
+    Before = -1,
 }

YDotNet/Document/Transactions/TransactionUpdateResult.cs

@@ -33,5 +33,5 @@ public enum TransactionUpdateResult
     /// <summary>
     ///     Failure when trying to decode JSON content.
     /// </summary>
-    Other = 5
+    Other = 5,
 }

YDotNet/Document/Types/Events/EventBranchTag.cs

@@ -34,5 +34,5 @@ public enum EventBranchTag : sbyte
     /// <summary>
     ///     This event holds an <see cref="XmlTextEvent" /> instance.
     /// </summary>
-    XmlText = 5
+    XmlText = 5,
 }

YDotNet/Document/Types/Events/EventChangeTag.cs

@@ -21,5 +21,5 @@ public enum EventChangeTag
     /// <summary>
     ///     Represents the update of content.
     /// </summary>
-    Retain
+    Retain,
 }

YDotNet/Document/Types/Events/EventDeltaTag.cs

@@ -21,5 +21,5 @@ public enum EventDeltaTag
     /// <summary>
     ///     Represents the update of content.
     /// </summary>
-    Retain
+    Retain,
 }

YDotNet/Document/Types/Events/EventKeyChangeTag.cs

@@ -18,5 +18,5 @@ public enum EventKeyChangeTag
     /// <summary>
     ///     Represents that the value under this key was updated.
     /// </summary>
-    Update
+    Update,
 }

YDotNet/Document/Types/Events/EventPathSegmentTag.cs

@@ -13,5 +13,5 @@ public enum EventPathSegmentTag : sbyte
     /// <summary>
     ///     The <see cref="EventPathSegment" /> contains an <see cref="int" /> value.
     /// </summary>
-    Index = 2
+    Index = 2,
 }

YDotNet/Document/UndoManagers/Events/UndoEventKind.cs

@@ -13,5 +13,5 @@ public enum UndoEventKind
     /// <summary>
     ///     Represents a redo operation.
     /// </summary>
-    Redo = 1
+    Redo = 1,
 }

YDotNet/Document/UndoManagers/UndoManagerOptions.cs

@@ -19,7 +19,7 @@ internal UndoManagerOptionsNative ToNative()
     {
         return new UndoManagerOptionsNative
         {
-            CaptureTimeoutMilliseconds = CaptureTimeoutMilliseconds
+            CaptureTimeoutMilliseconds = CaptureTimeoutMilliseconds,
         };
     }
 }

YDotNet/Native/Types/Branches/BranchKind.cs

@@ -7,5 +7,5 @@ internal enum BranchKind
     Map = 2,
     Text = 3,
     XmlElement = 4,
-    XmlText = 5
+    XmlText = 5,
 }

YDotNet/Native/Types/Events/EventChangeTagNative.cs

@@ -4,5 +4,5 @@ internal enum EventChangeTagNative : sbyte
 {
     Add = 1,
     Remove = 2,
-    Retain = 3
+    Retain = 3,
 }

YDotNet/Native/Types/Events/EventDeltaTagNative.cs

@@ -4,5 +4,5 @@ internal enum EventDeltaTagNative : sbyte
 {
     Add = 1,
     Remove = 2,
-    Retain = 3
+    Retain = 3,
 }

YDotNet/Native/Types/Events/EventKeyChangeTagNative.cs

@@ -4,5 +4,5 @@ internal enum EventKeyChangeTagNative : byte
 {
     Add = 4,
     Remove = 5,
-    Update = 6
+    Update = 6,
 }

YDotNet/Native/UndoManager/Events/UndoEventKindNative.cs

@@ -3,5 +3,5 @@ namespace YDotNet.Native.UndoManager.Events;
 internal enum UndoEventKindNative : byte
 {
     Undo = 0,
-    Redo = 1
+    Redo = 1,
 }