fix(gh-9345): improve E2E folder restoration by handling sync termination and blacklist updates

Signed-off-by: Kevin Andrews <kevin@nforced.uk>

Author: Caffe1neAdd1ct

src/gui/e2eefoldermanager.cpp

@@ -113,20 +113,30 @@ void E2EFolderManager::restoreE2eFoldersForAccount(const AccountPtr &account)
 
         auto blackList = folder->journalDb()->getSelectiveSyncList(SyncJournalDb::SelectiveSyncBlackList, &ok);
         qCDebug(lcE2eFolderManager) << "Current blacklist:" << blackList;
+        const auto blackListSize = blackList.size();
 
         for (const auto &pathToRemoveFromBlackList : foldersToRemoveFromBlacklist) {
             blackList.removeAll(pathToRemoveFromBlackList);
         }
 
-        folder->journalDb()->setSelectiveSyncList(SyncJournalDb::SelectiveSyncBlackList, blackList);
-        folder->journalDb()->setSelectiveSyncList(SyncJournalDb::SelectiveSyncE2eFoldersToRemoveFromBlacklist, {});
+        if (blackList.size() != blackListSize) {
+            if (folder->isSyncRunning()) {
+                qCDebug(lcE2eFolderManager) << "Folder is syncing, terminating to prevent E2E folder deletion";
+                folderTerminateSyncAndUpdateBlackList(blackList, folder, foldersToRemoveFromBlacklist);
+                ++foldersProcessed;
+                continue;
+            }
 
-        for (const auto &pathToRemoteDiscover : foldersToRemoveFromBlacklist) {
-            folder->journalDb()->schedulePathForRemoteDiscovery(pathToRemoteDiscover);
-        }
+            folder->journalDb()->setSelectiveSyncList(SyncJournalDb::SelectiveSyncBlackList, blackList);
+            folder->journalDb()->setSelectiveSyncList(SyncJournalDb::SelectiveSyncE2eFoldersToRemoveFromBlacklist, {});
 
-        folderMan->scheduleFolder(folder);
-        ++foldersProcessed;
+            for (const auto &pathToRemoteDiscover : foldersToRemoveFromBlacklist) {
+                folder->journalDb()->schedulePathForRemoteDiscovery(pathToRemoteDiscover);
+            }
+
+            folderMan->scheduleFolder(folder);
+            ++foldersProcessed;
+        }
     }
 
     if (foldersProcessed > 0) {
@@ -136,4 +146,31 @@ void E2EFolderManager::restoreE2eFoldersForAccount(const AccountPtr &account)
     }
 }
 
+void E2EFolderManager::folderTerminateSyncAndUpdateBlackList(const QStringList &blackList, OCC::Folder *folder, const QStringList &foldersToRemoveFromBlacklist)
+{
+    if (_folderConnections.contains(folder->alias())) {
+        qCWarning(lcE2eFolderManager) << "Folder " << folder->alias() << "is already terminating the sync.";
+        return;
+    }
+    // in case sync is already running - terminate it and start a new one
+    const QMetaObject::Connection syncTerminatedConnection = connect(folder, &Folder::syncFinished, this, [this, blackList, folder, foldersToRemoveFromBlacklist]() {
+        const auto foundConnectionIt = _folderConnections.find(folder->alias());
+        if (foundConnectionIt != _folderConnections.end()) {
+            disconnect(*foundConnectionIt);
+            _folderConnections.erase(foundConnectionIt);
+        }
+        
+        folder->journalDb()->setSelectiveSyncList(SyncJournalDb::SelectiveSyncBlackList, blackList);
+        folder->journalDb()->setSelectiveSyncList(SyncJournalDb::SelectiveSyncE2eFoldersToRemoveFromBlacklist, {});
+
+        for (const auto &pathToRemoteDiscover : foldersToRemoveFromBlacklist) {
+            folder->journalDb()->schedulePathForRemoteDiscovery(pathToRemoteDiscover);
+        }
+
+        FolderMan::instance()->scheduleFolder(folder);
+    });
+    _folderConnections.insert(folder->alias(), syncTerminatedConnection);
+    folder->slotTerminateSync();
+}
+
 } // namespace OCC

src/gui/e2eefoldermanager.h

@@ -4,11 +4,14 @@
 #pragma once
 
 #include <QObject>
+#include <QMap>
 #include "account.h"
 #include "accountmanager.h"
 
 namespace OCC {
 
+class Folder;
+
 /**
  * @brief Stateless bridge between E2E encryption and folder management
  *
@@ -36,7 +39,9 @@ private slots:
 
     void connectE2eSignals(const AccountPtr &account);
     void restoreE2eFoldersForAccount(const AccountPtr &account);
+    void folderTerminateSyncAndUpdateBlackList(const QStringList &blackList, OCC::Folder *folder, const QStringList &foldersToRemoveFromBlacklist);
 
+    QMap<QString, QMetaObject::Connection> _folderConnections;
     static E2EFolderManager *_instance;
 };
 

src/libsync/discovery.cpp

@@ -252,7 +252,7 @@ void ProcessDirectoryJob::process()
             continue;
         }
 
-        const auto isBlacklisted = _queryServer == InBlackList || _discoveryData->isInSelectiveSyncBlackList(path._original) || isEncryptedFolderButE2eIsNotSetup;
+        const auto isBlacklisted = _queryServer == InBlackList || _discoveryData->isInSelectiveSyncBlackList(path._original);
 
         const auto willBeExcluded = handleExcluded(path._target, e, entries, isHidden, isBlacklisted);
 

test/teste2eefoldermanager.cpp

@@ -23,12 +23,6 @@ class TestE2EFolderManager : public QObject
     Q_OBJECT
 
 private slots:
-    void initTestCase()
-    {
-        OCC::Logger::instance()->setLogFlush(true);
-        OCC::Logger::instance()->setLogDebug(true);
-        QStandardPaths::setTestModeEnabled(true);
-    }
 
     void init()
     {
@@ -360,4 +354,4 @@ private slots:
 };
 
 QTEST_GUILESS_MAIN(TestE2EFolderManager)
-#include "teste2eefoldermanager.moc"
+#include "teste2eefoldermanager.moc"