fix(file-provider): Sync state for excluded lock files.

- Added debug logging to file provider extension about its sync actions.
- Added debug logging to file provider extension about its sync state reported to the main app through the socket.
- Added debug logging to the main app about the sync state received from a file provider extension through the socket.
- Updated sync action management to not consider the exclusion of a lock file as an error.

Signed-off-by: Iva Horn <[email protected]>

Author: i2h3

shell_integration/MacOSX/NextcloudIntegration/FileProviderExt/FileProviderExtension+ClientInterface.swift

@@ -218,12 +218,14 @@ extension FileProviderExtension: NSFileProviderServicing, ChangeNotificationInte
         actionsLock.lock()
 
         guard oldActions.isEmpty != syncActions.isEmpty else {
+            logger.debug("Cancelling synchronization state report due to lack of state change.")
             actionsLock.unlock()
             return
         }
 
         let command = "FILE_PROVIDER_DOMAIN_SYNC_STATE_CHANGE"
         var argument: String?
+
         if oldActions.isEmpty, !syncActions.isEmpty {
             argument = "SYNC_STARTED"
         } else if !oldActions.isEmpty, syncActions.isEmpty {
@@ -233,8 +235,13 @@ extension FileProviderExtension: NSFileProviderServicing, ChangeNotificationInte
 
         actionsLock.unlock()
 
-        guard let argument else { return }
-        logger.debug("Reporting sync \(argument)")
+        guard let argument else {
+            logger.error("State argument is nil!")
+            return
+        }
+
+        logger.debug("Reporting synchronization state.", [.name: argument])
+
         let message = command + ":" + argument + "\n"
         socketClient?.sendMessage(message)
     }

shell_integration/MacOSX/NextcloudIntegration/FileProviderExt/FileProviderExtension.swift

@@ -90,6 +90,8 @@ import OSLog
     }
 
     func insertSyncAction(_ actionId: UUID) {
+        logger.debug("Inserting synchronization action.", [.item: actionId])
+
         actionsLock.lock()
         let oldActions = syncActions
         syncActions.insert(actionId)
@@ -98,6 +100,8 @@ import OSLog
     }
 
     func insertErrorAction(_ actionId: UUID) {
+        logger.debug("Inserting error action.", [.item: actionId])
+
         actionsLock.lock()
         let oldActions = syncActions
         syncActions.remove(actionId)
@@ -107,6 +111,8 @@ import OSLog
     }
 
     func removeSyncAction(_ actionId: UUID) {
+        logger.debug("Removing synchronization action.", [.item: actionId])
+
         actionsLock.lock()
         let oldActions = syncActions
         syncActions.remove(actionId)
@@ -274,11 +280,23 @@ import OSLog
                 log: log
             )
 
-            if error != nil {
-                insertErrorAction(actionId)
-                signalEnumerator(completionHandler: { _ in })
-            } else {
+            if error == nil {
                 removeSyncAction(actionId)
+            } else {
+                // Do not consider the exclusion of a lock file a synchronization error resulting in a misleading status report because exclusion is expected.
+                // Though, the exclusion error code is only available starting with macOS 13, hence this logic reads a bit more cumbersome.
+
+                if #available(macOS 13.0, *) {
+                    if isLockFileName(itemTemplate.filename), let fileProviderError = error as? NSFileProviderError, fileProviderError.code == .excludedFromSync {
+                        removeSyncAction(actionId)
+                    } else {
+                        insertErrorAction(actionId)
+                        signalEnumerator(completionHandler: { _ in })
+                    }
+                } else {
+                    insertErrorAction(actionId)
+                    signalEnumerator(completionHandler: { _ in })
+                }
             }
 
             logger.debug("Calling item creation completion handler.", [.item: item?.itemIdentifier, .name: item?.filename, .error: error])

src/gui/macOS/fileprovidersocketcontroller.cpp

@@ -99,6 +99,7 @@ void FileProviderSocketController::parseReceivedLine(const QString &receivedLine
         reportSyncState("SYNC_FINISHED");
         return;
     } else if (command == "FILE_PROVIDER_DOMAIN_SYNC_STATE_CHANGE") {
+        qCDebug(lcFileProviderSocketController) << "Received FILE_PROVIDER_DOMAIN_SYNC_STATE_CHANGE:" << argument;
         reportSyncState(argument);
         return;
     }