fix(file-provider): Clean up change delivery items after change session completed

Signed-off-by: Claudio Cambra <developer@claudiocambra.com>

Author: claucambra

shell_integration/MacOSX/NextcloudFileProviderKit/Sources/NextcloudFileProviderKit/Database/FilesDatabaseManager+ChangeDelivery.swift

@@ -112,7 +112,7 @@ extension FilesDatabaseManager {
             .map { ($0.sequence, $0.metadataData, $0.deleted) }
     }
 
-    /// Advance an active session to its next continuation anchor, or mark it complete.
+    /// Advance an active session to its next continuation anchor, or remove it after the final batch.
     func advanceChangeDeliverySession(
         sessionId: String,
         nextSequence: Int,
@@ -125,15 +125,22 @@ extension FilesDatabaseManager {
         }
 
         try? database.write {
-            session.nextSequence = nextSequence
-            session.completed = completed
-            if let nextAnchorKey {
-                session.currentAnchorKey = nextAnchorKey
-            }
+            if completed {
+                database.objects(RealmChangeDeliveryItem.self)
+                    .filter("sessionId == %@", sessionId)
+                    .forEach { database.delete($0) }
+                database.delete(session)
+            } else {
+                session.nextSequence = nextSequence
+                session.completed = false
+                if let nextAnchorKey {
+                    session.currentAnchorKey = nextAnchorKey
+                }
 
-            database.objects(RealmChangeDeliveryItem.self)
-                .filter("sessionId == %@ AND sequence < %@", sessionId, nextSequence)
-                .forEach { database.delete($0) }
+                database.objects(RealmChangeDeliveryItem.self)
+                    .filter("sessionId == %@ AND sequence < %@", sessionId, nextSequence)
+                    .forEach { database.delete($0) }
+            }
         }
     }
 

shell_integration/MacOSX/NextcloudFileProviderKit/Tests/NextcloudFileProviderKitTests/FilesDatabaseManagerTests.swift

@@ -25,6 +25,50 @@ final class FilesDatabaseManagerTests: NextcloudFileProviderKitTestCase {
         XCTAssertNotNil(Self.dbManager, "FilesDatabaseManager should be initialized")
     }
 
+    func testCompletedChangeDeliverySessionRemovesPersistedState() {
+        let sessionId = "completed-change-delivery-\(name)"
+        let metadata = SendableItemMetadata(
+            ocId: "change-delivery-item-\(name)",
+            fileName: "item.txt",
+            account: Self.account
+        )
+
+        XCTAssertTrue(
+            Self.dbManager.createChangeDeliverySession(
+                sessionId: sessionId,
+                anchorKey: "initial-anchor-\(name)",
+                finalAnchorRawValue: Data("final-anchor".utf8),
+                updated: [metadata],
+                deleted: [],
+                incomplete: false
+            )
+        )
+
+        let database = Self.dbManager.ncDatabase()
+        XCTAssertNotNil(database.object(ofType: RealmChangeDeliverySession.self, forPrimaryKey: sessionId))
+        XCTAssertEqual(
+            database.objects(RealmChangeDeliveryItem.self)
+                .where { $0.sessionId == sessionId }
+                .count,
+            1
+        )
+
+        Self.dbManager.advanceChangeDeliverySession(
+            sessionId: sessionId,
+            nextSequence: 1,
+            nextAnchorKey: nil,
+            completed: true
+        )
+
+        let cleanedDatabase = Self.dbManager.ncDatabase()
+        XCTAssertNil(cleanedDatabase.object(ofType: RealmChangeDeliverySession.self, forPrimaryKey: sessionId))
+        XCTAssertTrue(
+            cleanedDatabase.objects(RealmChangeDeliveryItem.self)
+                .where { $0.sessionId == sessionId }
+                .isEmpty
+        )
+    }
+
     func testSchema203MigrationBackfillsCanonicalPathKeys() throws {
         let databaseDirectory = makeDatabaseDirectory()
         let domainIdentifier = NSFileProviderDomainIdentifier("migration-test")