fix(NKFile+Extensions): prevent __NC_ROOT__ from appearing

With nextcloud/NextcloudKit#169 the sync root folder name has changed.
This required consumers of the API to update the handling of the root
folder case accordingly.

BUG: nextcloud/desktop#8832
Signed-off-by: Jyrki Gadinger <nilsding@nilsding.org>

Author: nilsding

Sources/NextcloudFileProviderKit/Enumeration/Enumerator+SyncEngine.swift

@@ -183,7 +183,7 @@ extension Enumerator {
             guard receivedFile.directory ||
                   serverUrl == dbManager.account.davFilesUrl ||
                   receivedFile.fullUrlMatches(dbManager.account.davFilesUrl + "/.") ||
-                  (receivedFile.fileName == "." && receivedFile.serverUrl == "..")
+                  (receivedFile.fileName == NextcloudKit.shared.nkCommonInstance.rootFileName && receivedFile.serverUrl == dbManager.account.davFilesUrl)
             else {
                 logger.debug("Read item is a file, converting.", [.url: serverUrl])
                 var metadata = receivedFile.toItemMetadata()

Sources/NextcloudFileProviderKit/Extensions/NKFile+Extensions.swift

@@ -26,14 +26,13 @@ extension NKFile {
 
         // Don't ask me why, NextcloudKit renames and moves the root folder details
         // Also don't ask me why, but, NextcloudKit marks the NKFile for this as not a directory
-        let rootRequiresFixup = serverUrl == ".." && fileName == "."
+        let rootServerUrl = urlBase + Account.webDavFilesUrlSuffix + userId
+        let rootRequiresFixup = serverUrl == rootServerUrl && fileName == NextcloudKit.shared.nkCommonInstance.rootFileName
         let ocId = rootRequiresFixup
             ? NSFileProviderItemIdentifier.rootContainer.rawValue
             : self.ocId
         let directory = rootRequiresFixup ? true : self.directory
-        let serverUrl = rootRequiresFixup
-            ? urlBase + Account.webDavFilesUrlSuffix + userId
-            : self.serverUrl
+        let serverUrl = rootRequiresFixup ? rootServerUrl : self.serverUrl
         let fileName = rootRequiresFixup ? "" : self.fileName
 
         return SendableItemMetadata(

Tests/Interface/MockRemoteItem.swift

@@ -140,7 +140,7 @@ public class MockRemoteItem: Equatable {
         let isRoot = identifier == NSFileProviderItemIdentifier.rootContainer.rawValue
         var file = NKFile()
         file.fileName = isRoot
-            ? "."
+            ? "__NC_ROOT__"
             : trashbinOriginalLocation?.split(separator: "/").last?.toString() ?? name
         file.size = size
         file.date = creationDate
@@ -149,7 +149,7 @@ public class MockRemoteItem: Equatable {
         file.ocId = identifier
         file.fileId = identifier.replacingOccurrences(of: trashedItemIdSuffix, with: "")
         file.serverUrl = isRoot
-            ? ".."
+            ? serverUrl + "/remote.php/dav/files/" + userId
             : parent?.remotePath ?? remotePath
         file.account = account
         file.user = username

Tests/InterfaceTests/MockRemoteInterfaceTests.swift

@@ -503,9 +503,9 @@ final class MockRemoteInterfaceTests: XCTestCase {
         let targetRootFile = result.files.first
         let expectedRoot = remoteInterface.rootItem
         XCTAssertEqual(targetRootFile?.ocId, expectedRoot?.identifier)
-        XCTAssertEqual(targetRootFile?.fileName, ".") // NextcloudKit gives the root dir this name
+        XCTAssertEqual(targetRootFile?.fileName, "__NC_ROOT__") // NextcloudKit gives the root dir this name
         XCTAssertNotEqual(targetRootFile?.fileName, expectedRoot?.name)
-        XCTAssertEqual(targetRootFile?.serverUrl, "..") // NextcloudKit gives the root dir this surl
+        XCTAssertEqual(targetRootFile?.serverUrl, "https://mock.nc.com/remote.php/dav/files/testUserId") // NextcloudKit gives the root dir this url
         XCTAssertEqual(targetRootFile?.date, expectedRoot?.creationDate)
         XCTAssertEqual(targetRootFile?.etag, expectedRoot?.versionIdentifier)
 

Tests/NextcloudFileProviderKitTests/NKFileExtensionTests.swift

@@ -46,8 +46,8 @@ final class NKFileExtensionsTests: NextcloudFileProviderKitTestCase {
         // which has a special serverUrl and fileName.
         let rootNKFile = createNKFile(
             ocId: "rootId",
-            serverUrl: "..", // Special root value
-            fileName: ".",   // Special root value
+            serverUrl: "https://mock.nc.com/remote.php/dav/files/testUserId", // Special root value
+            fileName: "__NC_ROOT__",   // Special root value
             directory: false // NextcloudKit sometimes marks the root as not a directory
         )
 
@@ -99,8 +99,8 @@ final class NKFileExtensionsTests: NextcloudFileProviderKitTestCase {
         // 1. Arrange: Create an array of NKFiles where the first item is the special root.
         let rootNKFile = createNKFile(
             ocId: "rootId", // This will be overridden by the logic
-            serverUrl: "..",
-            fileName: ".",
+            serverUrl: "https://mock.nc.com/remote.php/dav/files/testUserId",
+            fileName: "__NC_ROOT__",
             directory: false // Mimic NextcloudKit behavior
         )
         let childNKFile = createNKFile(