Make sync scheduling more predictable

Author: TheOneRing

src/gui/folder.cpp

@@ -19,7 +19,6 @@
 #include "account.h"
 #include "accountstate.h"
 #include "application.h"
-#include "common/checksums.h"
 #include "common/depreaction.h"
 #include "common/filesystembase.h"
 #include "common/syncjournalfilerecord.h"
@@ -55,9 +54,6 @@
 #include <QTimer>
 #include <QUrl>
 
-#include <QApplication>
-#include <QMessageBox>
-
 using namespace Qt::Literals::StringLiterals;
 using namespace std::chrono_literals;
 
@@ -85,7 +81,9 @@ Folder::Folder(const FolderDefinition &definition, const AccountStatePtr &accoun
     _timeSinceLastSyncStart.start();
     _timeSinceLastSyncDone.start();
 
-    setSyncState(definition.paused ? SyncResult::Paused : SyncResult::Queued);
+    // set the sync state without emiting a signal
+    _syncResult.setStatus(definition.paused ? SyncResult::Paused : SyncResult::Queued);
+
     // check if the local path exists
     if (checkLocalPath()) {
         // those errors should not persist over sessions
@@ -100,7 +98,8 @@ Folder::Folder(const FolderDefinition &definition, const AccountStatePtr &accoun
 
         connect(_accountState.data(), &AccountState::isConnectedChanged, this, &Folder::canSyncChanged);
 
-        connect(_engine.data(), &SyncEngine::finished, this, &Folder::slotSyncFinished);
+        // use a direct connection, the folder status has to be up to date
+        connect(_engine.data(), &SyncEngine::finished, this, &Folder::slotSyncFinished, Qt::DirectConnection);
 
         connect(_engine.data(), &SyncEngine::transmissionProgress, this,
             [this](const ProgressInfo &pi) { Q_EMIT ProgressDispatcher::instance()->progressInfo(this, pi); });
@@ -398,8 +397,8 @@ void Folder::setSyncState(SyncResult::Status state)
 {
     const auto oldIsRunning = isSyncRunning();
     if (state != _syncResult.status()) {
+        qCDebug(lcFolder) << u"State of" << path() << u"changed to" << state << u"old state" << _syncResult.status();
         _syncResult.setStatus(state);
-        qCDebug(lcFolder) << u"State of" << path() << u"changed to" << state;
         Q_EMIT syncStateChange();
         if (oldIsRunning != isSyncRunning()) {
             Q_EMIT isSyncRunningChanged();
@@ -882,9 +881,7 @@ void Folder::startSync()
     }
 
     _engine->setIgnoreHiddenFiles(_definition.ignoreHiddenFiles);
-    QMetaObject::invokeMethod(_engine.data(), &SyncEngine::startSync, Qt::QueuedConnection);
-
-    Q_EMIT syncStarted();
+    _engine->startSync();
 }
 
 void Folder::setDirtyNetworkLimits()
@@ -936,7 +933,6 @@ void Folder::slotSyncFinished(bool success)
         qCInfo(lcFolder) << u"SyncEngine finished without problem.";
     }
     _fileLog->finish();
-    showSyncResultPopup();
 
     auto anotherSyncNeeded = false;
 
@@ -975,10 +971,10 @@ void Folder::slotSyncFinished(bool success)
 
     if (syncStatus != SyncResult::Undefined) {
         setSyncState(syncStatus);
+        showSyncResultPopup();
     }
 
-    // syncStateChange from setSyncState needs to be emitted first
-    QTimer::singleShot(0, this, [this] { Q_EMIT syncFinished(_syncResult); });
+    Q_EMIT syncFinished(_syncResult);
 
     _lastSyncDuration = std::chrono::milliseconds(_timeSinceLastSyncStart.elapsed());
     _timeSinceLastSyncDone.start();

src/gui/folder.h

@@ -222,7 +222,6 @@ class OPENCLOUD_GUI_EXPORT Folder : public QObject
 
 Q_SIGNALS:
     void syncStateChange();
-    void syncStarted();
     void syncFinished(const SyncResult &result);
     void syncPausedChanged(Folder *, bool paused);
     void canSyncChanged();
@@ -352,8 +351,6 @@ private Q_SLOTS:
 
     QScopedPointer<SyncRunFileLog> _fileLog;
 
-    QTimer _scheduleSelfTimer;
-
     /**
      * Setting up vfs is a async operation
      */

src/gui/folderman.cpp

@@ -381,34 +381,6 @@ bool FolderMan::isAnySyncRunning() const
     return false;
 }
 
-void FolderMan::slotFolderSyncStarted()
-{
-    auto f = qobject_cast<Folder *>(sender());
-    OC_ASSERT(f);
-    if (!f)
-        return;
-
-    qCInfo(lcFolderMan) << u">========== Sync started for folder [" << f->shortGuiLocalPath() << u"] of account ["
-                        << f->accountState()->account()->displayNameWithHost() << u"]";
-}
-
-/*
-  * a folder indicates that its syncing is finished.
-  * Start the next sync after the system had some milliseconds to breath.
-  * This delay is particularly useful to avoid late file change notifications
-  * (that we caused ourselves by syncing) from triggering another spurious sync.
-  */
-void FolderMan::slotFolderSyncFinished(const SyncResult &)
-{
-    auto f = qobject_cast<Folder *>(sender());
-    OC_ASSERT(f);
-    if (!f)
-        return;
-
-    qCInfo(lcFolderMan) << u"<========== Sync finished for folder [" << f->shortGuiLocalPath() << u"] of account ["
-                        << f->accountState()->account()->displayNameWithHost() << u"]";
-}
-
 Folder *FolderMan::addFolder(const AccountStatePtr &accountState, const FolderDefinition &folderDefinition)
 {
     // Choose a db filename
@@ -452,8 +424,6 @@ Folder *FolderMan::addFolderInternal(
     // See matching disconnects in unloadFolder().
     if (!folder->hasSetupError()) {
         connect(folder, &Folder::syncStateChange, _socketApi.get(), [folder, this] { _socketApi->slotUpdateFolderView(folder); });
-        connect(folder, &Folder::syncStarted, this, &FolderMan::slotFolderSyncStarted);
-        connect(folder, &Folder::syncFinished, this, &FolderMan::slotFolderSyncFinished);
         connect(folder, &Folder::syncStateChange, this, [folder, this] { Q_EMIT folderSyncStateChange(folder); });
         connect(folder, &Folder::syncPausedChanged, this, &FolderMan::slotFolderSyncPaused);
         connect(folder, &Folder::canSyncChanged, this, &FolderMan::slotFolderCanSyncChanged);

src/gui/folderman.h

@@ -55,30 +55,6 @@ class TrayOverallStatusResult
     SyncResult _overallStatus;
 };
 
-/**
- * @brief The FolderMan class
- * @ingroup gui
- *
- * The FolderMan knows about all loaded folders and is responsible for
- * scheduling them when necessary.
- *
- * A folder is scheduled if:
- * - The configured force-sync-interval has expired
- *   (_timeScheduler and slotScheduleFolderByTime())
- *
- * - A folder watcher receives a notification about a file change
- *   (_folderWatchers and Folder::slotWatchedPathsChanged())
- *
- * - The folder etag on the server has changed
- *   (_etagPollTimer)
- *
- * - The locks of a monitored file are released
- *   (_lockWatcher and slotWatchedFileUnlocked())
- *
- * - There was a sync error or a follow-up sync is requested
- *   (_timeScheduler and slotScheduleFolderByTime()
- *    and Folder::slotSyncFinished())
- */
 class OPENCLOUD_GUI_EXPORT FolderMan : public QObject
 {
     Q_OBJECT
@@ -282,8 +258,6 @@ public Q_SLOTS:
 private Q_SLOTS:
     void slotFolderSyncPaused(Folder *, bool paused);
     void slotFolderCanSyncChanged();
-    void slotFolderSyncStarted();
-    void slotFolderSyncFinished(const SyncResult &);
 
     void slotRemoveFoldersForAccount(const AccountStatePtr &accountState);
 

src/gui/scheduling/syncscheduler.cpp

@@ -235,7 +235,7 @@ void SyncScheduler::startNext()
             _currentSync.clear();
             startNext();
         },
-        Qt::SingleShotConnection);
+        static_cast<Qt::ConnectionType>(Qt::DirectConnection | Qt::SingleShotConnection));
     qCInfo(lcSyncScheduler) << u"Starting sync for" << _currentSync->path() << u"QueueSize:" << _queue->size();
     _currentSync->startSync();
     _syncTimer.reset();
@@ -268,7 +268,7 @@ Folder *SyncScheduler::currentSync()
 void SyncScheduler::terminateCurrentSync(const QString &reason)
 {
     if (_currentSync && _currentSync->isReady()) {
-        qCInfo(lcSyncScheduler) << u"folder " << _currentSync->path() << _currentSync->syncState() << u" Terminating!";
+        qCInfo(lcSyncScheduler) << u"folder" << _currentSync->path() << _currentSync->syncState() << u"Terminating!";
         if (OC_ENSURE(_currentSync->syncEngine().isSyncRunning())) {
             _currentSync->syncEngine().abort(reason);
         }